<!DOCTYPE html>
<html>
<!-- Created by GNU Texinfo 7.1, https://www.gnu.org/software/texinfo/ -->
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<!-- Copyright © 1988-2023 Free Software Foundation, Inc.

Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.3 or
any later version published by the Free Software Foundation; with the
Invariant Sections being "Funding Free Software", the Front-Cover
Texts being (a) (see below), and with the Back-Cover Texts being (b)
(see below).  A copy of the license is included in the section entitled
"GNU Free Documentation License".

(a) The FSF's Front-Cover Text is:

A GNU Manual

(b) The FSF's Back-Cover Text is:

You have freedom to copy and modify this GNU Manual, like GNU
     software.  Copies published by the Free Software Foundation raise
     funds for GNU development. -->
<title>Plugins attr (GNU Compiler Collection (GCC) Internals)</title>

<meta name="description" content="Plugins attr (GNU Compiler Collection (GCC) Internals)">
<meta name="keywords" content="Plugins attr (GNU Compiler Collection (GCC) Internals)">
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
<meta name="viewport" content="width=device-width,initial-scale=1">

<link href="index.html" rel="start" title="Top">
<link href="Option-Index.html" rel="index" title="Option Index">
<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
<link href="Plugins.html" rel="up" title="Plugins">
<link href="Plugins-recording.html" rel="next" title="Plugins recording">
<link href="Plugins-description.html" rel="prev" title="Plugins description">
<style type="text/css">
<!--
a.copiable-link {visibility: hidden; text-decoration: none; line-height: 0em}
div.example {margin-left: 3.2em}
span:hover a.copiable-link {visibility: visible}
-->
</style>


</head>

<body lang="en">
<div class="section-level-extent" id="Plugins-attr">
<div class="nav-panel">
<p>
Next: <a href="Plugins-recording.html" accesskey="n" rel="next">Recording information about pass execution</a>, Previous: <a href="Plugins-description.html" accesskey="p" rel="prev">Giving information about a plugin</a>, Up: <a href="Plugins.html" accesskey="u" rel="up">Plugins</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Option-Index.html" title="Index" rel="index">Index</a>]</p>
</div>
<hr>
<h3 class="section" id="Registering-custom-attributes-or-pragmas"><span>24.6 Registering custom attributes or pragmas<a class="copiable-link" href="#Registering-custom-attributes-or-pragmas"> &para;</a></span></h3>

<p>For analysis (or other) purposes it is useful to be able to add custom
attributes or pragmas.
</p>
<p>The <code class="code">PLUGIN_ATTRIBUTES</code> callback is called during attribute
registration. Use the <code class="code">register_attribute</code> function to register
custom attributes.
</p>
<div class="example smallexample">
<pre class="example-preformatted">/* Attribute handler callback */
static tree
handle_user_attribute (tree *node, tree name, tree args,
                       int flags, bool *no_add_attrs)
{
  return NULL_TREE;
}

/* Attribute definition */
static struct attribute_spec user_attr =
  { &quot;user&quot;, 1, 1, false,  false, false, false, handle_user_attribute, NULL };

/* Plugin callback called during attribute registration.
Registered with register_callback (plugin_name, PLUGIN_ATTRIBUTES, register_attributes, NULL)
*/
static void
register_attributes (void *event_data, void *data)
{
  warning (0, G_(&quot;Callback to register attributes&quot;));
  register_attribute (&amp;user_attr);
}

</pre></div>


<p>The <i class="i">PLUGIN_PRAGMAS</i> callback is called once during pragmas
registration. Use the <code class="code">c_register_pragma</code>,
<code class="code">c_register_pragma_with_data</code>,
<code class="code">c_register_pragma_with_expansion</code>,
<code class="code">c_register_pragma_with_expansion_and_data</code> functions to register
custom pragmas and their handlers (which often want to call
<code class="code">pragma_lex</code>) from <samp class="file">c-family/c-pragma.h</samp>.
</p>
<div class="example smallexample">
<pre class="example-preformatted">/* Plugin callback called during pragmas registration. Registered with
     register_callback (plugin_name, PLUGIN_PRAGMAS,
                        register_my_pragma, NULL);
*/
static void
register_my_pragma (void *event_data, void *data)
{
  warning (0, G_(&quot;Callback to register pragmas&quot;));
  c_register_pragma (&quot;GCCPLUGIN&quot;, &quot;sayhello&quot;, handle_pragma_sayhello);
}
</pre></div>

<p>It is suggested to pass <code class="code">&quot;GCCPLUGIN&quot;</code> (or a short name identifying
your plugin) as the &ldquo;space&rdquo; argument of your pragma.
</p>
<p>Pragmas registered with <code class="code">c_register_pragma_with_expansion</code> or
<code class="code">c_register_pragma_with_expansion_and_data</code> support
preprocessor expansions. For example:
</p>
<div class="example smallexample">
<pre class="example-preformatted">#define NUMBER 10
#pragma GCCPLUGIN foothreshold (NUMBER)
</pre></div>

</div>



</body>
</html>
